home *** CD-ROM | disk | FTP | other *** search
/ Turnbull China Bikeride / Turnbull China Bikeride - Disc 2.iso / BARNET / ARMTEX / EXTRAS / TR2LATEX / tr2latex / ReadMe < prev    next >
Text File  |  1992-04-27  |  5KB  |  116 lines
  1. Please read this file before you install the program.
  2.  
  3. tr2latex: Troff-to-TeX translator
  4. $Id: README,v 2.2 1992/04/27 15:13:26 Christian_Engel Dist krischan $
  5. Copyright (C) by 1987 Kamal Al-Yahya, 1991,1992 Christian Engel.
  6.  
  7. This directory contains a program developed at the Stanford Exploration
  8. Project, Geophysics Department, by Kamal Al-Yahya.  It was modified and
  9. enhanced substantially by Christian Engel at the Rheinisch-Westfaelische
  10. Technische Hochschule at Aachen, Germany, Department of Computer Science 4.
  11. Copying the sources and the program to any other machine is permitted
  12. without prior permission provided that copyright messages are kept, no
  13. profit is made by copying the files, and modifications are clearly
  14. documented.
  15.  
  16. I would very much appreciate any comments or suggestions. My e-net
  17. address is
  18.         kamal@hanauma.stanford.edu
  19. If it doesn't work try
  20.         kamal%hanauma@score.stanford.edu
  21.  
  22. -----------------------------------------------------------------------------
  23.  
  24. It seems as if Kamal isn't to the net anymore.
  25.  
  26. I have made several modifications on Kamal's version 0.93 from the net.
  27. Thus I continued my revision numbering with 1.00. The actual revision is
  28. version $Revision: 2.2 $, $Date: 1992/04/27 15:13:26 $.
  29.  
  30. If you modify this source, if you found some bugs, or if you have some
  31. suggestions for improvements then e-mail me as well:
  32.         krischan@informatik.rwth-aachen.de
  33.  
  34. -----------------------------------------------------------------------------
  35.  
  36.             INSTALLATION INSTRUCTIONS
  37.  
  38. !!! No support of K&R anymore !!!
  39. Everything turned to ANSI-C. If you only have a K&R compiler transform
  40. the sources by a K&R to ANSI translator (e.g. ansi2knr from anonymous
  41. ftp: bongo.cc.utexas.edu, /source/X11R5/contrib/clients/xv-2.00/jpeg)
  42. or use tr2latex V1.04. Read file ``History'' for further informations.
  43.  
  44. In short, type ``make'' and then run it on the document (try the testfile):
  45.         tr2latex testfile > testfile.tex
  46.  
  47. In details:
  48.  
  49. - Use the adaequate Makefile: ``Makefile.unix'' under any *NIX system, 
  50.   ``Makefile.vms'' under VMS with public domain make, ``Makefile.mms''
  51.   under VMS with DEC MMS make package, ``Makefile.msc'' if you're running
  52.   Microsoft-C under MS-DOS, and ``Makefile.tc'' under Turbo-C. Copy it to
  53.   ``Makefile''.
  54.   Warning: I have developed and tested tr2latex just on SUNs.
  55.   Thus I've tested only the UNIX distribution. Other machines have been
  56.   supported by other people.
  57. - In the Makefile, define some macros adaequately. Read the comments in the
  58.   Makefile. Also, add the -O flag in CFLAGS if you want to (and the optimizer
  59.   is not buggy). The -O flag causes long compilation time but experience has
  60.   shown that it is unnecessary for this package; time saved in running time
  61.   is extremely small in the computers I used.
  62. - If the limit on your unsigned int is not 65535, change MAXLEN in
  63.   setups.h accordingly.
  64. - If you are installing on a MIPS M/2000, running RISCos, comment out the
  65.   line ``#    error "The COMPACT model is needed"'' from setups.h. Otherwise
  66.   an strange error
  67.   occurs through compilationAs
  68.   David Osborne <cczdao@mips.ccc.nottingham.ac.uk> noted a strange error
  69.   occurs through compilation
  70.   
  71. - In tr2latex.c, change the document type if you want. The default is article.
  72.   Also, change the style options to suit your taste. The default is
  73.   [troffms,11pt] if no flag is used and [troffman] if the -m flag is used.
  74. - Add necessary -D's to CFLAGS if you need them. The program recognizes the
  75.   following compiler-time definitions:
  76.        -Dtops20, -DANSI, -DMSC, -DNO_SGTTY
  77. - type ``make'' to produce the executable, called ``tr2latex''.
  78. - Run the translator on ``testfile'' and the manual page as follows
  79.         tr2latex testfile > testfile.tex
  80.         tr2latex -m tr2latex.man > tr2latex.man.tex
  81.   The first command will come up with the following warning:
  82.         > illegal TeX macro, ((, replacing it
  83.         > illegal TeX macro, )), replacing it
  84.         > I am not very good at tables
  85.         > I can only do very simple ones. You may need to check what I've done
  86.   Compare ``testfile.tex'' with ``testfile.tex-orig'' and
  87.   ``tr2latex.man.tex'' with ``tr2latex.man-tex-orig'':
  88.         diff testfile.tex testfile.tex-orig
  89.         diff tr2latex.man.tex tr2latex.man-tex-orig
  90.   If they are not identical (except for the date of conversion), you have not
  91.   installed it properly.
  92. - Modify troffms.sty and troffman.sty to suit your taste but keep the
  93.   necessary macro definitions as they will be needed when running latex.
  94.   Make sure the font names exist on your site. Change them if necessary.
  95. - Install tr2latex, the style files, and the manual page by running
  96.         make install
  97.   This is only possible for the super user on UNIX machines.
  98.  
  99.  
  100.             USING THE TRANSLATOR
  101.  
  102. You can run the program either by
  103.         tr2latex < file  > file.tex
  104. or
  105.         tr2latex file  > file.tex
  106. You are most likely to get messages on the standard error telling
  107. you about things it encounters and cannot do.
  108.  
  109. Now you have the translated document. Look at it and see if you
  110. can spot a major error. Run it through latex. If it runs and produces
  111. the dvi file, then print it. If you get latex error messages modify
  112. the translated document accordingly and repeat the latex run, and so on.
  113. I usually get away with one or two iterations.
  114.  
  115.  
  116.